Skip to main content
Version: 12.10.0

Audit Service Documentation

Overview​

The Audit Service is designed to enhance the monitoring and management of our mobile application's performance and reliability. It tracks various critical aspects such as exceptions, app crashes, and service log traces, storing them in a PostgreSQL database. These logs are then visualized on a Grafana dashboard allowing users to trace an ID and delve into the details of logs, including their functions and the times they occurred.

Components​

Mobile Application​

  • Exceptions & Errors: Captures all exceptions and errors occurring within the application.
  • App Crashes: Monitors and logs instances of application crashes.
  • Service Log Traces: Collects log traces from other integrated services.

Audit Service​

  • Function: Aggregates and processes logs from the mobile application.
  • Output: Stores processed logs in the PostgreSQL database.

PostgreSQL Database​

  • Function: Stores all logs collected by the Audit Service.
  • Query Capability: Allows querying of logs for detailed analysis.

Grafana Dashboard​

  • Function:
    • Visualizes the logs and metrics stored in the PostgreSQL database.
    • Users can trace an ID to view detailed information about logs, including the function and time of occurrence.
  • Features:
    • Real-Time Visualization: Displays real-time data and trends.
    • Customizable Metrics: Allows customization and filtering of metrics.
    • User-Friendly Interface: Provides an intuitive interface for easy navigation and interpretation of data.

Data Flow Diagram​

Importance of the Audit Service​

  1. Enhanced Monitoring: Provides deeper insights into the application's behavior and performance.
  2. Proactive Issue Resolution: Enables early detection and proactive resolution of issues, minimizing downtime.
  3. Data-Driven Decisions: Facilitates informed decision-making based on real-time metrics and trends.
  4. Compliance and Accountability: Ensures compliance with industry standards and provides a clear audit trail.

Benefits of the Grafana Dashboard​

  1. Improved Visibility: Offers a comprehensive view of the application's health and performance.
  2. Quick Diagnostics: Facilitates rapid identification and diagnosis of issues.
  3. Performance Optimization: Helps identify areas for optimization and improvement.

Conclusion​

The implementation of the Audit Service and Grafana Dashboard will significantly enhance our monitoring capabilities, contributing to the overall stability and performance of our application.